/*******************************************************************************
 * The MOSES project, model based software engineering of networked embedded systems.
 * 
 * Copyright (C) 2010-2013, University of Applied Sciences Wildau,
 * Telematics Research Group, http://www.tm.th-wildau.de/research-group
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses>.
 * 
 * Contributors:
 *     University of Applied Sciences Wildau - initial API and implementation
 * 
 * If you are interested in a commercial license please contact us via 
 * e-mail: ralf.vandenhouten@th-wildau.de.
 ******************************************************************************/
package de.thwildau.tm.moses.common.generator;

 

/**
 * Validator interface for programming languages. This interface should be used to check
 * whether specific parameter match to the language specification of the programming language.
 *
 * @author Thomas Kistel
 * @version $Revision: 758 $
 *
 */
public interface ILanguageValidator {
    
    /**
     * Returns <code>true</code>, if the given value is a keyword.
     * 
     * @param value the value
     * @return <code>true</code> if the <code>value</code> is a keyword
     */
    public boolean isKeyword(String value);
    
    /**
     * Returns <code>true</code>, if the given value is a valid package name.
     * 
     * @param value the value
     * @return <code>true</code>, if the given value is a valid package name
     */
    public boolean validPackageName(String value);
    
    /**
     * Returns <code>true</code>, if the given value is a valid class name.
     * 
     * @param value the value
     * @return <code>true</code>, if the given value is a valid class name
     */
    public boolean validClassName(String value);
    
    /**
     * Returns <code>true</code>, if the given value is a valid suffix for a class name.
     * 
     * @param value the value
     * @return <code>true</code>, if the given value is a valid suffix for a class name
     */
    public boolean validClassNameSuffix(String value);

    /**
     * Returns <code>true</code>, if the given value is a valid name for a field declaration.
     * 
     * @param the value
     * @return <code>true</code>, if the given value is a valid field name
     */
    public boolean validFieldName(String value);
}
